<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_60) on Sun Dec 20 21:23:29 CET 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ImporterWizardUI (gephi 0.9.0 API)</title>
<meta name="date" content="2015-12-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="ImporterWizardUI (gephi 0.9.0 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ImporterWizardUI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/gephi/io/importer/spi/ImporterUI.html" title="interface in org.gephi.io.importer.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/gephi/io/importer/spi/SpigotImporter.html" title="interface in org.gephi.io.importer.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/io/importer/spi/ImporterWizardUI.html" target="_top">Frames</a></li>
<li><a href="ImporterWizardUI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.io.importer.spi</div>
<h2 title="Interface ImporterWizardUI" class="title">Interface ImporterWizardUI</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ImporterWizardUI</span></pre>
<div class="block">Define importer settings wizard user interface.
 <p>
 Declared in the system as services (i.e. singleton), the role of UI classes
 is to provide user interface to configure importers and remember last used
 settings if needed. This service is designed to provide the different panels
 part of a spigot import wizard.
 <p>
 To be recognized by the system, implementations must just add the following
 annotation:
 <pre>@ServiceProvider(service=ImporterWizardUI.class)</pre></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mathieu Bastian</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/gephi/io/importer/spi/SpigotImporter.html" title="interface in org.gephi.io.importer.spi"><code>SpigotImporter</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#getCategory--">getCategory</a></span>()</code>
<div class="block">There are two levels for wizard UIs, the category and then the display
 name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the description for this importer</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#getDisplayName--">getDisplayName</a></span>()</code>
<div class="block">Returns the importer display name</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.openide.WizardDescriptor.Panel[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#getPanels--">getPanels</a></span>()</code>
<div class="block">Returns wizard panels.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#isUIForImporter-org.gephi.io.importer.spi.Importer-">isUIForImporter</a></span>(<a href="../../../../../org/gephi/io/importer/spi/Importer.html" title="interface in org.gephi.io.importer.spi">Importer</a>&nbsp;importer)</code>
<div class="block">Returns <code>true</code> if this UI belongs to the given importer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#setup-org.openide.WizardDescriptor.Panel-">setup</a></span>(org.openide.WizardDescriptor.Panel&nbsp;panel)</code>
<div class="block">Configure <code>panel</code> with previously remembered settings.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/spi/ImporterWizardUI.html#unsetup-org.gephi.io.importer.spi.SpigotImporter-org.openide.WizardDescriptor.Panel-">unsetup</a></span>(<a href="../../../../../org/gephi/io/importer/spi/SpigotImporter.html" title="interface in org.gephi.io.importer.spi">SpigotImporter</a>&nbsp;importer,
       org.openide.WizardDescriptor.Panel&nbsp;panel)</code>
<div class="block">Notify UI the settings panel has been closed and that new values can be
 written.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getDisplayName--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDisplayName()</pre>
<div class="block">Returns the importer display name</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the importer display name</dd>
</dl>
</li>
</ul>
<a name="getCategory--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCategory</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCategory()</pre>
<div class="block">There are two levels for wizard UIs, the category and then the display
 name. Returns the importer category.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the importer category</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription()</pre>
<div class="block">Returns the description for this importer</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the description test</dd>
</dl>
</li>
</ul>
<a name="getPanels--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPanels</h4>
<pre>org.openide.WizardDescriptor.Panel[]&nbsp;getPanels()</pre>
<div class="block">Returns wizard panels.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>panels of the current importer</dd>
</dl>
</li>
</ul>
<a name="setup-org.openide.WizardDescriptor.Panel-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre>void&nbsp;setup(org.openide.WizardDescriptor.Panel&nbsp;panel)</pre>
<div class="block">Configure <code>panel</code> with previously remembered settings. This
 method is called after <code>getPanels()</code> to push settings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>panel</code> - the panel that settings are to be set</dd>
</dl>
</li>
</ul>
<a name="unsetup-org.gephi.io.importer.spi.SpigotImporter-org.openide.WizardDescriptor.Panel-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsetup</h4>
<pre>void&nbsp;unsetup(<a href="../../../../../org/gephi/io/importer/spi/SpigotImporter.html" title="interface in org.gephi.io.importer.spi">SpigotImporter</a>&nbsp;importer,
             org.openide.WizardDescriptor.Panel&nbsp;panel)</pre>
<div class="block">Notify UI the settings panel has been closed and that new values can be
 written. Settings can be read in <code>panel</code> and written
 <code>importer</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>importer</code> - the importer that settings are to be written</dd>
<dd><code>panel</code> - the panel that settings are read</dd>
</dl>
</li>
</ul>
<a name="isUIForImporter-org.gephi.io.importer.spi.Importer-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isUIForImporter</h4>
<pre>boolean&nbsp;isUIForImporter(<a href="../../../../../org/gephi/io/importer/spi/Importer.html" title="interface in org.gephi.io.importer.spi">Importer</a>&nbsp;importer)</pre>
<div class="block">Returns <code>true</code> if this UI belongs to the given importer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>importer</code> - the importer that has to be tested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the UI is matching with
 <code>importer</code>, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ImporterWizardUI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/gephi/io/importer/spi/ImporterUI.html" title="interface in org.gephi.io.importer.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/gephi/io/importer/spi/SpigotImporter.html" title="interface in org.gephi.io.importer.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/io/importer/spi/ImporterWizardUI.html" target="_top">Frames</a></li>
<li><a href="ImporterWizardUI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2015 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All rights reserved.</small></p>
</body>
</html>
